home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / man.zip / MAN.DOC < prev    next >
Text File  |  1986-12-31  |  5KB  |  114 lines
  1.  
  2.  
  3.  
  4.       MAN usage:  
  5.                     MAN [d:][path]progname
  6.  
  7.       Man lists  the .doc  file for progname (located in the current search
  8.       path  or  in  MANPATH),  using  the  list  program  specified  in the
  9.       environment variable, MANLIST.  If MANLIST is not specified, MAN uses
  10.       MORE or TYPE, in that order.  
  11.  
  12.  
  13.       About MAN:
  14.  
  15.       My hard disk is full of public domain and shareware  software which I
  16.       can never remember how to use.  Fortunately, most of it has some sort
  17.       of documentation, which I keep on  disk since  bits grow  faster than
  18.       trees.    A  given  program,  say  WHATSUP.EXE, will generally have a
  19.       corresponding manual file, say WHATSUP.DOC.  So if I want to remember
  20.       how to use WHATSUP, all I have to do is look at the .DOC file.  Well,
  21.       actually, first I have to FIND the .DOC file.   Probably it's  in the
  22.       same directory as WHATSUP.EXE, but I don't know where that is either.
  23.       And I shouldn't have to know!   After  all, the  directory containing
  24.       WHATSUP.EXE is  surely listed in my DOS search path.  Why not let the
  25.       computer check all the directories in my search  path until  it finds
  26.       WHATSUP.DOC, and then list WHATSUP.DOC on the screen?  So I wrote MAN
  27.       to do that.
  28.  
  29.       Using MAN:
  30.  
  31.       A computer user named  Sam  is  using  Carrot-Calc  to  calculate the
  32.       expected yield of small plastic explosive charge.  Suddenly, a bug in
  33.       the BIOS of his CloneCorp computer causes Carrot-Calc to crash.   Sam
  34.       is  REALLY  mad,  but  he  remembers  downloading a piece of software
  35.       called DONBUGME that is supposed to  fix  the  BIOS  bug.    He can't
  36.       remember the syntax for DONBUGME, so he types
  37.  
  38.           MAN DONBUGME                                 ,
  39.  
  40.       and  the  computer  responds  by  listing DONBUGME.DOC on the screen.
  41.       After reading the documentation, Sam is able to fix his BIOS bug, and
  42.       he finishes  his yield  calculation just in time for Saturday morning
  43.       cartoons.
  44.  
  45.       How MAN works:
  46.  
  47.       In the  example  above,  MAN  started  by  looking  in  Sam's default
  48.       directory (on the default drive) for DONBUGME.DOC.  If it didn't find
  49.       DONBUGME.DOC there, MAN checked each directory  in Sam's  search path
  50.       until it  was successful.   Then it attempted to list DONBUGME.DOC to
  51.       the screen using DOS's MORE command.  If MAN couldn't locate MORE.COM
  52.       in any of Sam's search path directories, it used the DOS TYPE command
  53.       to list the file.  MAN only finds files with the .DOC  extension, and
  54.       it only finds those that are in the current directory, or in a search
  55.       path directory.  To list .DOC  files  that  aren't  in  one  of these
  56.       places, one  must tell  MAN where  to look for them.  For example, if
  57.       COSTLY.DOC is in A:\HOSPITAL, and A:\HOSPITAL is neither  the default
  58.  
  59.  
  60.       directory, nor  one of  the directories  in the search path, then one
  61.       must type
  62.  
  63.           MAN A:\HOSPITAL\COSTLY                       ,
  64.  
  65.       if MAN is to find COSTLY.DOC.  The A: could be omitted, if A:  is the
  66.       default drive.
  67.  
  68.       Changing the way MAN works:
  69.  
  70.       Some people are more organized than I am, and keep most of their .DOC
  71.       files in one directory, say C:\DOCFILES.  They want MAN to look there
  72.       first.  The way to accomplish this is to add the line
  73.  
  74.           SET MANPATH=C:\DOCFILES
  75.  
  76.       to  the  AUTOEXEC.BAT  file.   The environmental variable MANPATH can
  77.       contain a list of  directories where MAN should look before it checks
  78.       the ones in search path  (but after it checks the default directory).
  79.       The directory list in MANPATH has the same form  as a  directory list
  80.       for  the  DOS  search path, but  MANPATH is initialized with the  SET
  81.       command instead  of the  PATH command.  Here is  another  example  of
  82.       initializing MANPATH:
  83.  
  84.           SET MANPATH=\EYEDOC;\SLYDOC;\YOURDOC;\MYDOC;      .
  85.  
  86.       Some people  might like to use something other than MORE to list .DOC
  87.       files.  For instance,  many  people  prefer  Vernon  D.  Buerg's LIST
  88.       utility.   Convincing MAN  to use  LIST instead  of MORE is simple --
  89.       just add the following line to AUTOEXEC.BAT:
  90.  
  91.           SET MANLIST=LIST                             .
  92.  
  93.       This works if LIST is in the DOS search path.  If  not, MAN  needs to
  94.       know where to find LIST, e.g.
  95.  
  96.           SET MANLIST=C:\SHOPPING\LIST                 .
  97.  
  98.       Other programs  could be used in place of MORE.  MAN assumes that any
  99.       program specified in MANLIST should be invoked with the syntax
  100.  
  101.           LISTER DOCFILE                               .
  102.  
  103.       The law and MAN:
  104.  
  105.       MAN and this document  are  Copyright  1986  by  David  L.  Rick (the
  106.       author).    Both  may  be  freely  distributed for noncommercial use.
  107.       Commercial users must obtain a license from the author.  Write to him
  108.       in care  of 4000  Ingersoll, Des  Moines, IA  50312.  Modification of
  109.       MAN.EXE is expressly prohibited.
  110.  
  111.       NOTICE: THOSE WHO USE THIS SOFTWARE DO SO AT THEIR  OWN RISK.   IN NO
  112.       EVENT WILL  THE AUTHOR  BE LIABLE FOR DAMAGES ARISING FROM THE USE OR
  113.       MISUSE OF THIS SOFTWARE AND/OR ITS DOCUMENTATION.
  114.